Skip to content

add stream name to the ingest script param#1696

Merged
nikhilsinhaparseable merged 1 commit into
parseablehq:mainfrom
nikhilsinhaparseable:ingest-stream
Jun 23, 2026
Merged

add stream name to the ingest script param#1696
nikhilsinhaparseable merged 1 commit into
parseablehq:mainfrom
nikhilsinhaparseable:ingest-stream

Conversation

@nikhilsinhaparseable

@nikhilsinhaparseable nikhilsinhaparseable commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Chores
    • Updated ingestion scripts to accept a metric stream name as a required command-line parameter
    • Modified configuration generation to use the specified stream name instead of default values
    • Updated script documentation with new usage instructions

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: d8ad7995-9a6b-4dae-8767-23cb05eb512d

📥 Commits

Reviewing files that changed from the base of the PR and between c849704 and 317db74.

📒 Files selected for processing (2)
  • scripts/ingest.ps1
  • scripts/ingest.sh

Walkthrough

Both scripts/ingest.ps1 and scripts/ingest.sh are updated to accept a new required stream argument (positioned between host[:port] and api_key). The Setup-FluentBit/setup_fluent_bit function signatures, internal validation, Fluent Bit config generation (X-P-Stream header), dispatch call sites, and help/usage text are all updated to reflect the new argument contract.

Changes

Dynamic stream name for Fluent Bit ingest scripts

Layer / File(s) Summary
PowerShell: param block, Setup-FluentBit, config, dispatch, and docs
scripts/ingest.ps1
Extends the param block with $Param3/$Param4; adds StreamName parameter to Setup-FluentBit with validation; sets X-P-Stream from $StreamName instead of a hardcoded value; updates the default dispatch to validate and pass -StreamName $Param2, -ApiKey $Param3, -TenantId $Param4; revises Show-Help usage text and examples.
Bash: setup_fluent_bit, config, dispatch, and docs
scripts/ingest.sh
Reassigns STREAM_NAME=$2, API_KEY=$3, TENANT_ID=$4 in setup_fluent_bit; requires all three to be non-empty; populates Header X-P-Stream from $STREAM_NAME; updates call site to pass "$1" "$2" "$3" "${4:-}"; updates --help usage, examples, and argument count validation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • parseablehq/parseable#1489: Introduced the original Setup-FluentBit/setup_fluent_bit functions and Fluent Bit config generation that this PR directly modifies to support dynamic stream names.
  • parseablehq/parseable#1667: Modified the same argument parsing and Fluent Bit setup path in both scripts to add API-key and tenant auth; this PR extends that same contract with the stream name argument.

Suggested reviewers

  • nitisht

Poem

🐇 A stream once was fixed, carved in stone,
Now flows where you say, not left alone.
Pass the name on the line,
The config aligns—
X-P-Stream sings a tune of your own! 🎵

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning No pull request description was provided; the required template sections are entirely missing. Add a description following the template: explain the goal, rationale for changes, and confirm testing and documentation have been completed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding stream name as a parameter to the ingest scripts.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@nikhilsinhaparseable nikhilsinhaparseable merged commit ad4e004 into parseablehq:main Jun 23, 2026
12 checks passed
ygndotgg pushed a commit to ygndotgg/parseable that referenced this pull request Jun 23, 2026
parmesant pushed a commit to parmesant/parseable that referenced this pull request Jun 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants